Support [DataMember] IsRequired in NewtonsoftDataContractResolver #2644
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Havunen
added a commit
to Havunen/DotSwashbuckle2
that referenced
this pull request
Feb 12, 2024
Havunen
added a commit
to Havunen/DotSwashbuckle
that referenced
this pull request
Feb 18, 2024
Collaborator
|
Thanks for contributing - if you'd like to continue with this pull request, please rebase against the default branch to pick up our new CI. We'd also require tests for this scenario. |
Contributor
Author
|
I'll rebase once #2799 is merged |
Collaborator
|
FYI #2799 was merged a month ago. |
src/Swashbuckle.AspNetCore.Newtonsoft/SchemaGenerator/JsonPropertyExtensions.cs
Show resolved
Hide resolved
test/Swashbuckle.AspNetCore.Newtonsoft.Test/Fixtures/JsonPropertyAnnotatedType.cs
Outdated
Show resolved
Hide resolved
test/Swashbuckle.AspNetCore.Newtonsoft.Test/Fixtures/JsonRequiredAnnotatedType.cs
Show resolved
Hide resolved
As DataMember implementation comes after the implementation for [JsonProperty] and [JsonObject], we want to be sure that the current behavior is not bypassed.
Add test cases for DataMember (IsRequired and Name). It seems that NewtonSoft's ResolveContract correctly set the Required, using [DataMember], [JsonProperpty] and [JsonRequired] so we can directly use it instead of the IsRequiredSpecifed extension method.
Newtonsoft do all the work for us, handling [JsonProperty(Required = Required.Always)] or [JsonRequired] or [DataMember(IsRequired = true)] and filling the JsonProperty.Required field.
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## master #2644 +/- ##
==========================================
+ Coverage 88.46% 90.61% +2.14%
==========================================
Files 95 74 -21
Lines 3364 2962 -402
Branches 577 469 -108
==========================================
- Hits 2976 2684 -292
+ Misses 388 278 -110
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
martincostello
approved these changes
Aug 1, 2024
Collaborator
|
Thanks! |
Collaborator
|
Version 6.7.1 is now available from NuGet.org which includes this change. |
This was referenced Aug 1, 2025
This was referenced Jan 19, 2026
Open
Open
Open
Open
Open
Open
Open
Bump Swashbuckle.AspNetCore from 5.6.3 to 9.0.0
hopethackray/skills-secure-repository-supply-chain#8
Open
Open
Open
Open
Open
Bump Swashbuckle.AspNetCore from 5.6.3 to 9.0.0
andrewglass3/skills-secure-repository-supply-chain#8
Open
Open
Open
Bump Swashbuckle.AspNetCore from 5.6.3 to 9.0.0
dtriplett-mj/skills-secure-repository-supply-chain#8
Open
Open
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #2383